<!DOCTYPE html>
<html lang="en">
  <head>
    <title>Classes  Reference</title>
    <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
    <link rel="stylesheet" type="text/css" href="css/highlight.css" />
    <meta charset="utf-8">
    <script src="js/jquery.min.js" defer></script>
    <script src="js/jazzy.js" defer></script>
    
    <script src="js/lunr.min.js" defer></script>
    <script src="js/typeahead.jquery.js" defer></script>
    <script src="js/jazzy.search.js" defer></script>
  </head>
  <body>

    <a name="//apple_ref/swift/Section/Classes" class="dashAnchor"></a>

    <a title="Classes  Reference"></a>

    <header class="header">
      <p class="header-col header-col--primary">
        <a class="header-link" href="index.html">
          PredicateFlow 1.5 Docs
        </a>
         (77% documented)
      </p>
    
      <p class="header-col--secondary">
        <form role="search" action="search.json">
          <input type="text" placeholder="Search documentation" data-typeahead>
        </form>
      </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="https://github.com/andreadelfante/PredicateFlow">
            <img class="header-icon" src="img/gh.png"/>
            View on GitHub
          </a>
        </p>
    
        <p class="header-col header-col--secondary">
          <a class="header-link" href="dash-feed://https%3A%2F%2Fandreadelfante.github.io%2FPredicateFlow%2Fdocsets%2FPredicateFlow.xml">
            <img class="header-icon" src="img/dash.png"/>
            Install in Dash
          </a>
        </p>
    </header>

    <p class="breadcrumbs">
      <a class="breadcrumb" href="index.html">PredicateFlow Reference</a>
      <img class="carat" src="img/carat.png" />
      Classes  Reference
    </p>

    <div class="content-wrapper">
      <nav class="navigation">
        <ul class="nav-groups">
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="Classes.html">Classes</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/BasicComparisonQuery.html">BasicComparisonQuery</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/BoolPredicateProperty.html">BoolPredicateProperty</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/CollectionProperty.html">CollectionProperty</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes.html#/s:13PredicateFlow20CompoundFieldBuilderC">CompoundFieldBuilder</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/CompoundablePredicateField.html">CompoundablePredicateField</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/ObjectProperty.html">ObjectProperty</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/PredicateBuilder.html">PredicateBuilder</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/PredicateProperty.html">PredicateProperty</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/StringComparisonQuery.html">StringComparisonQuery</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Classes/StringPredicateProperty.html">StringPredicateProperty</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="Enums.html">Enumerations</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Enums/StringComparisonOption.html">StringComparisonOption</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="Extensions.html">Extensions</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Extensions/LinkingObjects.html">LinkingObjects</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Extensions/List.html">List</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Extensions/Results.html">Results</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Extensions/SortDescriptor.html">SortDescriptor</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="Protocols.html">Protocols</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/CompoundablePredicate.html">CompoundablePredicate</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/CompoundablePredicateResult.html">CompoundablePredicateResult</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/FlowComparable.html">FlowComparable</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/FlowEquatable.html">FlowEquatable</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/FlowNillable.html">FlowNillable</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/FlowStringComparable.html">FlowStringComparable</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/GeneratedPredicateSchema.html">GeneratedPredicateSchema</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/GroupingPredicate.html">GroupingPredicate</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/PredicateField.html">PredicateField</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/PredicatePropertyBuilder.html">PredicatePropertyBuilder</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/PredicateQuery.html">PredicateQuery</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols/PredicateResult.html">PredicateResult</a>
              </li>
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Protocols.html#/s:13PredicateFlow0A6SchemaP">PredicateSchema</a>
              </li>
            </ul>
          </li>
          <li class="nav-group-name">
            <a class="nav-group-name-link" href="Structs.html">Structures</a>
            <ul class="nav-group-tasks">
              <li class="nav-group-task">
                <a class="nav-group-task-link" href="Structs/SubqueryProperty.html">SubqueryProperty</a>
              </li>
            </ul>
          </li>
        </ul>
      </nav>
      <article class="main-content">

        <section class="section">
          <div class="section-content top-matter">
            <h1>Classes</h1>
            <p>The following classes are available globally.</p>

          </div>
        </section>

        <section class="section">
          <div class="section-content">
            <div class="task-group">
              <ul class="item-container">
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow04BoolA8PropertyC"></a>
                    <a name="//apple_ref/swift/Class/BoolPredicateProperty" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow04BoolA8PropertyC">BoolPredicateProperty</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Defines a bool predicate property.</p>

                        <a href="Classes/BoolPredicateProperty.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">BoolPredicateProperty</span> <span class="p">:</span> <span class="kt"><a href="Classes/CompoundablePredicateField.html">CompoundablePredicateField</a></span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow18CollectionPropertyC"></a>
                    <a name="//apple_ref/swift/Class/CollectionProperty" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow18CollectionPropertyC">CollectionProperty</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Defines a collection predicate property.</p>

                        <a href="Classes/CollectionProperty.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">CollectionProperty</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt"><a href="Classes/CompoundablePredicateField.html">CompoundablePredicateField</a></span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow14ObjectPropertyC"></a>
                    <a name="//apple_ref/swift/Class/ObjectProperty" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow14ObjectPropertyC">ObjectProperty</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Defines an object predicate property.</p>

                        <a href="Classes/ObjectProperty.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">ObjectProperty</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt"><a href="Classes/CompoundablePredicateField.html">CompoundablePredicateField</a></span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt"><a href="Protocols/GeneratedPredicateSchema.html">GeneratedPredicateSchema</a></span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow012CompoundableA5FieldC"></a>
                    <a name="//apple_ref/swift/Class/CompoundablePredicateField" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow012CompoundableA5FieldC">CompoundablePredicateField</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A predicate field that allows to concatenate parents fields.</p>

                        <a href="Classes/CompoundablePredicateField.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">CompoundablePredicateField</span> <span class="p">:</span> <span class="kt"><a href="Protocols/PredicateField.html">PredicateField</a></span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow0A8PropertyC"></a>
                    <a name="//apple_ref/swift/Class/PredicateProperty" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow0A8PropertyC">PredicateProperty</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Defines a generic predicate property.</p>

                        <a href="Classes/PredicateProperty.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">PredicateProperty</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt"><a href="Classes/CompoundablePredicateField.html">CompoundablePredicateField</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">PredicateProperty</span><span class="p">:</span> <span class="kt"><a href="Protocols/FlowEquatable.html">FlowEquatable</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">PredicateProperty</span><span class="p">:</span> <span class="kt"><a href="Protocols/FlowComparable.html">FlowComparable</a></span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow06StringA8PropertyC"></a>
                    <a name="//apple_ref/swift/Class/StringPredicateProperty" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow06StringA8PropertyC">StringPredicateProperty</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>Defines a string predicate property.</p>

                        <a href="Classes/StringPredicateProperty.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">StringPredicateProperty</span> <span class="p">:</span> <span class="kt"><a href="Classes/PredicateProperty.html">PredicateProperty</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">StringPredicateProperty</span><span class="p">:</span> <span class="kt"><a href="Protocols/FlowStringComparable.html">FlowStringComparable</a></span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow20BasicComparisonQueryC"></a>
                    <a name="//apple_ref/swift/Class/BasicComparisonQuery" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow20BasicComparisonQueryC">BasicComparisonQuery</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The basic comparison query class.</p>

                        <a href="Classes/BasicComparisonQuery.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">BasicComparisonQuery</span><span class="o">&lt;</span><span class="kt">T</span><span class="o">&gt;</span> <span class="p">:</span> <span class="kt"><a href="Protocols/PredicateQuery.html">PredicateQuery</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">BasicComparisonQuery</span><span class="p">:</span> <span class="kt"><a href="Protocols/FlowEquatable.html">FlowEquatable</a></span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">BasicComparisonQuery</span><span class="p">:</span> <span class="kt"><a href="Protocols/FlowComparable.html">FlowComparable</a></span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow21StringComparisonQueryC"></a>
                    <a name="//apple_ref/swift/Class/StringComparisonQuery" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow21StringComparisonQueryC">StringComparisonQuery</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>The string comparison query class.</p>

                        <a href="Classes/StringComparisonQuery.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">StringComparisonQuery</span> <span class="p">:</span> <span class="kt"><a href="Classes/BasicComparisonQuery.html">BasicComparisonQuery</a></span><span class="o">&lt;</span><span class="kt">String</span><span class="o">&gt;</span></code></pre>
<pre class="highlight swift"><code><span class="kd">extension</span> <span class="kt">StringComparisonQuery</span><span class="p">:</span> <span class="kt"><a href="Protocols/FlowStringComparable.html">FlowStringComparable</a></span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow20CompoundFieldBuilderC"></a>
                    <a name="//apple_ref/swift/Class/CompoundFieldBuilder" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow20CompoundFieldBuilderC">CompoundFieldBuilder</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>A builder to compound predicate fields.</p>

                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">CompoundFieldBuilder</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
                <li class="item">
                  <div>
                    <code>
                    <a name="/s:13PredicateFlow0A7BuilderC"></a>
                    <a name="//apple_ref/swift/Class/PredicateBuilder" class="dashAnchor"></a>
                    <a class="token" href="#/s:13PredicateFlow0A7BuilderC">PredicateBuilder</a>
                    </code>
                  </div>
                  <div class="height-container">
                    <div class="pointer-container"></div>
                    <section class="section">
                      <div class="pointer"></div>
                      <div class="abstract">
                        <p>This class is used to write a more readable and flowable predicate.</p>

                        <a href="Classes/PredicateBuilder.html" class="slightly-smaller">See more</a>
                      </div>
                      <div class="declaration">
                        <h4>Declaration</h4>
                        <div class="language">
                          <p class="aside-title">Swift</p>
                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">final</span> <span class="kd">class</span> <span class="kt">PredicateBuilder</span> <span class="p">:</span> <span class="kt"><a href="Protocols/GroupingPredicate.html">GroupingPredicate</a></span><span class="p">,</span> <span class="kt">CustomStringConvertible</span><span class="p">,</span> <span class="kt">CustomDebugStringConvertible</span></code></pre>

                        </div>
                      </div>
                    </section>
                  </div>
                </li>
              </ul>
            </div>
          </div>
        </section>

      </article>
    </div>
    <section class="footer">
      <p>&copy; 2020 <a class="link" href="https://twitter.com/a_delfante" target="_blank" rel="external">andreadelfante</a>. All rights reserved. (Last updated: 2020-12-10)</p>
      <p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
    </section>
  </body>
</div>
</html>
